test(query-persist-client-core/persist): add tests for removing an expired or busted cache in 'persistQueryClientRestore' by sukvvon · Pull Request #10876 · TanStack/query

sukvvon · 2026-06-04T03:09:19Z

🎯 Changes

Adds unit tests for persistQueryClientRestore covering the cache invalidation paths: the persisted client is removed when the cache is older than maxAge (expired) or when its buster does not match the configured one.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

Tests
- Enhanced test coverage for query persistence, including verification that expired cached states are properly removed and that mismatched validation values trigger correct cleanup behavior.

…pired or busted cache in 'persistQueryClientRestore'

coderabbitai · 2026-06-04T03:09:32Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7fbf7328-a814-4048-a76e-054783e5d2f5

📥 Commits

Reviewing files that changed from the base of the PR and between e6c26c0 and fb27fb8.

📒 Files selected for processing (1)

packages/query-persist-client-core/src/__tests__/persist.test.ts

📝 Walkthrough

Walkthrough

This PR adds two test cases to persistQueryClientRestore in persist.test.ts. The tests verify that persister.removeClient is called when cached data expires via maxAge or when the buster value mismatches the provided option.

Changes

persistQueryClientRestore invalidation tests

Layer / File(s)	Summary
Tests for expired cache and buster mismatch `packages/query-persist-client-core/src/__tests__/persist.test.ts`	Two new test cases added: one asserts `persister.removeClient` is called when persisted cache exceeds `maxAge`; the other asserts removal when the persisted `buster` value differs from the provided `buster` option. Both stub `persister.restoreClient` and verify the removal behavior.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

TanStack/query#10875: Reorganized the persist test structure for the same persistQueryClientRestore function.
TanStack/query#10874: Modifies persistQueryClientRestore tests by stubbing persister.restoreClient and asserting persister.removeClient behavior.
TanStack/query#10872: Adds persistQueryClientRestore test coverage validating the happy path where valid cache prevents removeClient invocation.

Poem

🐰 Cache grows stale, the buster calls foul,
So we test the cleanup with whiskers and howl—
When maxAge expires or keys disagree,
removeClient springs free, as tests prove it'll be!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and specifically describes the main change: adding tests for cache invalidation in persistQueryClientRestore.
Description check	✅ Passed	The description follows the repository template, includes all required sections with relevant details about the changes, and properly marks the release impact as dev-only.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch test/query-persist-client-core-restore-invalidate-cache

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

nx-cloud · 2026-06-04T03:09:46Z

View your CI Pipeline Execution ↗ for commit fb27fb8

Command	Status	Duration	Result
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	1m 1s	View ↗

☁️ Nx Cloud last updated this comment at 2026-06-04 03:19:38 UTC

github-actions · 2026-06-04T03:09:59Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

pkg-pr-new · 2026-06-04T03:18:25Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10876

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10876

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@10876

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10876

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10876

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10876

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10876

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10876

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10876

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10876

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10876

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10876

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10876

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10876

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10876

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10876

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10876

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10876

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10876

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10876

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10876

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10876

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10876

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10876

commit: fb27fb8

github-actions · 2026-06-04T03:19:39Z

size-limit report 📦

Path	Size
react full	12.11 KB (0%)
react minimal	9.08 KB (0%)

test(query-persist-client-core/persist): add tests for removing an ex…

fb27fb8

…pired or busted cache in 'persistQueryClientRestore'

sukvvon self-assigned this Jun 4, 2026

sukvvon merged commit 89bae56 into main Jun 4, 2026
11 of 12 checks passed

sukvvon deleted the test/query-persist-client-core-restore-invalidate-cache branch June 4, 2026 04:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test(query-persist-client-core/persist): add tests for removing an expired or busted cache in 'persistQueryClientRestore'#10876

test(query-persist-client-core/persist): add tests for removing an expired or busted cache in 'persistQueryClientRestore'#10876
sukvvon merged 1 commit into
mainfrom
test/query-persist-client-core-restore-invalidate-cache

sukvvon commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

nx-cloud Bot commented Jun 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 4, 2026

Uh oh!

pkg-pr-new Bot commented Jun 4, 2026

Uh oh!

github-actions Bot commented Jun 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

sukvvon commented Jun 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

nx-cloud Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 4, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Jun 4, 2026

Uh oh!

github-actions Bot commented Jun 4, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

nx-cloud Bot commented Jun 4, 2026 •

edited

Loading